cryptography/com.wire.kalium.cryptography/[jvm]MLSClientImpl

MLSClientImpl

class MLSClientImpl(coreCrypto: <Error class: unknown class>, defaultCipherSuite: <Error class: unknown class>) : MLSClient

Constructors

MLSClientImpl

constructor(coreCrypto: <Error class: unknown class>, defaultCipherSuite: <Error class: unknown class>)

Types

Companion

object Companion

Functions

addMember

open suspend override fun addMember(groupId: MLSGroupId, membersKeyPackages: List<MLSKeyPackage>): CommitBundle?

Add a user/client to an existing MLS group

clearPendingCommit

open suspend override fun clearPendingCommit(groupId: MLSGroupId)

Clear a pending commit which has not yet been accepted by the distribution service

clearPendingGroupExternalCommit

open suspend override fun clearPendingGroupExternalCommit(groupId: MLSGroupId)

Clear pending external commits

open suspend override fun close()

Free up any resources and shutdown the client.

commitAccepted

open suspend override fun commitAccepted(groupId: MLSGroupId)

Signal that last sent commit was accepted by the distribution service

commitPendingProposals

open suspend override fun commitPendingProposals(groupId: MLSGroupId): CommitBundle?

Create a commit for any pending proposals

conversationEpoch

open suspend override fun conversationEpoch(groupId: MLSGroupId): <Error class: unknown class>

Query the current epoch of a conversation

conversationExists

open suspend override fun conversationExists(groupId: MLSGroupId): Boolean

Query if a conversation exists

createConversation

open suspend override fun createConversation(groupId: MLSGroupId, externalSenders: ByteArray)

Create a new MLS conversation

decryptMessage

open suspend override fun decryptMessage(groupId: MLSGroupId, message: ApplicationMessage): List<DecryptedMessageBundle>

Decrypt an application message or a handshake message

deriveSecret

open suspend override fun deriveSecret(groupId: MLSGroupId, keyLength: <Error class: unknown class>): ByteArray

Derive a secret key from the current MLS group state

e2eiMlsInitOnly

open suspend override fun e2eiMlsInitOnly(enrollment: E2EIClient, certificateChain: CertificateChain): List<String>?

Init MLSClient after enrollment

e2eiNewActivationEnrollment

open suspend override fun e2eiNewActivationEnrollment(displayName: String, handle: String, teamId: String?, expiry: <Error class: unknown class>): E2EIClient

Enroll Wire E2EIdentity Client for E2EI when MLSClient already initialized

e2eiNewRotateEnrollment

open suspend override fun e2eiNewRotateEnrollment(displayName: String?, handle: String?, teamId: String?, expiry: <Error class: unknown class>): E2EIClient

Enroll Wire E2EI Enrollment Client for renewing certificate

e2eiRotateAll

open suspend override fun e2eiRotateAll(enrollment: E2EIClient, certificateChain: CertificateChain, newMLSKeyPackageCount: <Error class: unknown class>): RotateBundle

Generate new keypackages after E2EI certificate issued

encryptMessage

open suspend override fun encryptMessage(groupId: MLSGroupId, message: PlainMessage): ApplicationMessage

Encrypt a message for distribution in a group

generateKeyPackages

open suspend override fun generateKeyPackages(amount: Int): List<ByteArray>

Generate a fresh set of key packages.

getDefaultCipherSuite

open override fun getDefaultCipherSuite(): <Error class: unknown class>

Get the default ciphersuite for the client. the Default ciphersuite is set when creating the mls client.

getDeviceIdentities

open suspend override fun getDeviceIdentities(groupId: MLSGroupId, clients: List<CryptoQualifiedClientId>): List<WireIdentity>

Get the identity of given clients in the given conversation

getExternalSenders

open suspend override fun getExternalSenders(groupId: MLSGroupId): ExternalSenderKey

Get External Senders of an MLS conversation

getMLSCredentials

open suspend override fun getMLSCredentials(): CredentialType

The MLS Credentials based on the E2EI State

getPublicKey

open suspend override fun getPublicKey(): <Error class: unknown class><ByteArray, <Error class: unknown class>>

Public key of the client's identity.

getUserIdentities

open suspend override fun getUserIdentities(groupId: MLSGroupId, users: List<CryptoQualifiedID>): Map<String, List<WireIdentity>>

Get the identity of given users in the given conversation

isE2EIEnabled

open suspend override fun isE2EIEnabled(): Boolean

The E2EI State for the current MLS Client

isGroupVerified

open suspend override fun isGroupVerified(groupId: MLSGroupId): E2EIConversationState

Conversation E2EI Verification Status

joinByExternalCommit

open suspend override fun joinByExternalCommit(publicGroupState: ByteArray): CommitBundle

Request to join an existing conversation by external commit

joinConversation

open suspend override fun joinConversation(groupId: MLSGroupId, epoch: <Error class: unknown class>): HandshakeMessage

Request to join an existing conversation

members

open suspend override fun members(groupId: MLSGroupId): List<CryptoQualifiedClientId>

Current members of the group.

mergePendingGroupFromExternalCommit

open suspend override fun mergePendingGroupFromExternalCommit(groupId: MLSGroupId)

Request to merge an existing conversation by external commit

processWelcomeMessage

open suspend override fun processWelcomeMessage(message: WelcomeMessage): WelcomeBundle

Process an incoming welcome message

removeMember

open suspend override fun removeMember(groupId: MLSGroupId, members: List<CryptoQualifiedClientId>): CommitBundle

Remove a user/client from an existing MLS group

updateKeyingMaterial

open suspend override fun updateKeyingMaterial(groupId: MLSGroupId): CommitBundle

Update your keying material for an existing conversation you're a member of.

validKeyPackageCount

open suspend override fun validKeyPackageCount(): <Error class: unknown class>

Number of valid key packages which haven't been consumed

wipeConversation

open suspend override fun wipeConversation(groupId: MLSGroupId)